/**
 * @file
 * @brief BACnet EventNotification encode and decode functions
 * @author John Minack <minack@users.sourceforge.net>
 * @author Steve Karg <skarg@users.sourceforge.net>
 * @date 2008
 * @copyright SPDX-License-Identifier: MIT
 */
#ifndef BACNET_EVENT_H_
#define BACNET_EVENT_H_

#include <stdint.h>
#include <stdbool.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacapp.h"
#include "bacnet/timestamp.h"
#include "bacnet/bacpropstates.h"
#include "bacnet/bacdevobjpropref.h"
#include "bacnet/authentication_factor.h"

typedef enum {
    CHANGE_OF_VALUE_BITS,
    CHANGE_OF_VALUE_REAL
} CHANGE_OF_VALUE_TYPE;

typedef enum {
    COMMAND_FAILURE_BINARY_PV,
    COMMAND_FAILURE_UNSIGNED
} COMMAND_FAILURE_TYPE;

/*
** Based on UnconfirmedEventNotification-Request
*/

/** Enable decoding of certain large event parameters.
 *  If set to 0, the values are decoded and discarded,
 *  and the encoders are disabled. */
#ifndef BACNET_EVENT_EXTENDED_ENABLED
#define BACNET_EVENT_EXTENDED_ENABLED 0
#endif

#ifndef BACNET_EVENT_DOUBLE_OUT_OF_RANGE_ENABLED
#define BACNET_EVENT_DOUBLE_OUT_OF_RANGE_ENABLED 0
#endif

#ifndef BACNET_EVENT_SIGNED_OUT_OF_RANGE_ENABLED
#define BACNET_EVENT_SIGNED_OUT_OF_RANGE_ENABLED 0
#endif

#ifndef BACNET_EVENT_UNSIGNED_OUT_OF_RANGE_ENABLED
#define BACNET_EVENT_UNSIGNED_OUT_OF_RANGE_ENABLED 0
#endif

#ifndef BACNET_EVENT_CHANGE_OF_CHARACTERSTRING_ENABLED
#define BACNET_EVENT_CHANGE_OF_CHARACTERSTRING_ENABLED 0
#endif

#ifndef BACNET_EVENT_CHANGE_OF_STATUS_FLAGS_ENABLED
#define BACNET_EVENT_CHANGE_OF_STATUS_FLAGS_ENABLED 0
#endif

#ifndef BACNET_EVENT_CHANGE_OF_RELIABILITY_ENABLED
#define BACNET_EVENT_CHANGE_OF_RELIABILITY_ENABLED 0
#endif

#ifndef BACNET_EVENT_CHANGE_OF_DISCRETE_VALUE_ENABLED
#define BACNET_EVENT_CHANGE_OF_DISCRETE_VALUE_ENABLED 0
#endif

#ifndef BACNET_EVENT_CHANGE_OF_TIMER_ENABLED
#define BACNET_EVENT_CHANGE_OF_TIMER_ENABLED 0
#endif

#ifndef BACNET_DECODE_COMPLEX_EVENT_TYPE_PARAMETERS
#define BACNET_DECODE_COMPLEX_EVENT_TYPE_PARAMETERS 0
#endif

/** Max complex-event-type property-values to decode. Events with more values
 * fail to decode. */
#ifndef BACNET_COMPLEX_EVENT_TYPE_MAX_PARAMETERS
#define BACNET_COMPLEX_EVENT_TYPE_MAX_PARAMETERS 5
#endif

typedef struct BACnetEventExtendedParameter {
    uint8_t tag; /* application tag data type */
    union {
        /* NULL - not needed as it is encoded in the tag alone */
        float Real;
        bool Boolean;
        BACNET_UNSIGNED_INTEGER Unsigned_Int;
        int32_t Signed_Int;
        double Double;
        BACNET_OCTET_STRING *Octet_String;
        BACNET_CHARACTER_STRING *Character_String;
        BACNET_BIT_STRING *Bit_String;
        uint32_t Enumerated;
        BACNET_DATE Date;
        BACNET_TIME Time;
        BACNET_OBJECT_ID Object_Id;
        BACNET_DATE_TIME Date_Time;
        BACNET_PROPERTY_VALUE *Property_Value;
    } type;
} BACNET_EVENT_EXTENDED_PARAMETER;

typedef struct BACnetEventDiscreteValue {
    uint8_t tag; /* application tag data type */
    union {
        bool Boolean;
        BACNET_UNSIGNED_INTEGER Unsigned_Int;
        int32_t Signed_Int;
        uint32_t Enumerated;
        BACNET_CHARACTER_STRING *Character_String;
        BACNET_OCTET_STRING *Octet_String;
        BACNET_DATE Date;
        BACNET_TIME Time;
        BACNET_OBJECT_ID Object_Id;
        BACNET_DATE_TIME Date_Time;
    } type;
} BACNET_EVENT_DISCRETE_VALUE;

typedef struct BACnet_Event_Notification_Data {
    uint32_t processIdentifier;
    BACNET_OBJECT_ID initiatingObjectIdentifier;
    BACNET_OBJECT_ID eventObjectIdentifier;
    BACNET_TIMESTAMP timeStamp;
    uint32_t notificationClass;
    uint8_t priority;
    BACNET_EVENT_TYPE eventType;
    /* OPTIONAL - Set to NULL if not being used */
    BACNET_CHARACTER_STRING *messageText;
    BACNET_NOTIFY_TYPE notifyType;
    bool ackRequired;
    BACNET_EVENT_STATE fromState;
    BACNET_EVENT_STATE toState;
    /*
     ** Each of these structures in the union maps to a particular eventtype
     ** Based on BACnetNotificationParameters
     */

    union {
        /*
         ** EVENT_CHANGE_OF_BITSTRING
         */
        struct {
            BACNET_BIT_STRING referencedBitString;
            BACNET_BIT_STRING statusFlags;
        } changeOfBitstring;
        /*
         ** EVENT_CHANGE_OF_STATE
         */
        struct {
            BACNET_PROPERTY_STATE newState;
            BACNET_BIT_STRING statusFlags;
        } changeOfState;
        /*
         ** EVENT_CHANGE_OF_VALUE
         */
        struct {
            union {
                BACNET_BIT_STRING changedBits;
                float changeValue;
            } newValue;
            CHANGE_OF_VALUE_TYPE tag;
            BACNET_BIT_STRING statusFlags;
        } changeOfValue;
        /*
         ** EVENT_COMMAND_FAILURE
         */
        struct {
            union {
                BACNET_BINARY_PV binaryValue;
                BACNET_UNSIGNED_INTEGER unsignedValue;
            } commandValue;
            COMMAND_FAILURE_TYPE tag;
            BACNET_BIT_STRING statusFlags;
            union {
                BACNET_BINARY_PV binaryValue;
                BACNET_UNSIGNED_INTEGER unsignedValue;
            } feedbackValue;
        } commandFailure;
        /*
         ** EVENT_FLOATING_LIMIT
         */
        struct {
            float referenceValue;
            BACNET_BIT_STRING statusFlags;
            float setPointValue;
            float errorLimit;
        } floatingLimit;
        /*
         ** EVENT_OUT_OF_RANGE
         */
        struct {
            float exceedingValue;
            BACNET_BIT_STRING statusFlags;
            float deadband;
            float exceededLimit;
        } outOfRange;
        /*
         ** EVENT_CHANGE_OF_LIFE_SAFETY
         */
        struct {
            BACNET_LIFE_SAFETY_STATE newState;
            BACNET_LIFE_SAFETY_MODE newMode;
            BACNET_BIT_STRING statusFlags;
            BACNET_LIFE_SAFETY_OPERATION operationExpected;
        } changeOfLifeSafety;
#if BACNET_EVENT_EXTENDED_ENABLED
        /*  EVENT_EXTENDED
            extended [9] SEQUENCE {
                vendor-id [0] Unsigned16,
                extended-event-type [1] Unsigned,
                parameters [2] SEQUENCE OF CHOICE {
                    null NULL,
                    real REAL,
                    unsigned Unsigned,
                    boolean BOOLEAN,
                    integer INTEGER,
                    double Double,
                    octetstring OCTET STRING,
                    characterstring CharacterString,
                    bitstring BIT STRING,
                    enumerated ENUMERATED,
                    date Date,
                    time Time,
                    objectidentifier BACnetObjectIdentifier,
                    property-value [0] BACnetDeviceObjectPropertyValue
                }
            } */
        struct {
            uint16_t vendorID;
            BACNET_UNSIGNED_INTEGER extendedEventType;
            BACNET_EVENT_EXTENDED_PARAMETER parameters;
        } extended;
#endif
        /*
         ** EVENT_BUFFER_READY
         */
        struct {
            BACNET_DEVICE_OBJECT_PROPERTY_REFERENCE bufferProperty;
            uint32_t previousNotification;
            uint32_t currentNotification;
        } bufferReady;
        /*
         ** EVENT_UNSIGNED_RANGE
         */
        struct {
            uint32_t exceedingValue;
            BACNET_BIT_STRING statusFlags;
            uint32_t exceededLimit;
        } unsignedRange;
        /*
         ** EVENT_ACCESS_EVENT
         */
        struct {
            BACNET_ACCESS_EVENT accessEvent;
            BACNET_BIT_STRING statusFlags;
            BACNET_UNSIGNED_INTEGER accessEventTag;
            BACNET_TIMESTAMP accessEventTime;
            BACNET_DEVICE_OBJECT_REFERENCE accessCredential;
            BACNET_AUTHENTICATION_FACTOR authenticationFactor;
            /* OPTIONAL - Set authenticationFactor.format_type to
               AUTHENTICATION_FACTOR_MAX if not being used */
        } accessEvent;
#if BACNET_EVENT_DOUBLE_OUT_OF_RANGE_ENABLED
        /*  EVENT_DOUBLE_OUT_OF_RANGE
            double-out-of-range[14] SEQUENCE {
                exceeding-value[0] Double,
                status-flags[1] BACnetStatusFlags,
                deadband[2] Double,
                exceeded-limit[3] Double
            } */
        struct {
            double exceedingValue;
            BACNET_BIT_STRING statusFlags;
            double deadband;
            double exceededLimit;
        } doubleOutOfRange;
#endif
#if BACNET_EVENT_SIGNED_OUT_OF_RANGE_ENABLED
        /*  EVENT_SIGNED_OUT_OF_RANGE
            signed-out-of-range[14] SEQUENCE {
                exceeding-value[0] Integer,
                status-flags[1] BACnetStatusFlags,
                deadband[2] Unsigned,
                exceeded-limit[3] Integer
            } */
        struct {
            int32_t exceedingValue;
            BACNET_BIT_STRING statusFlags;
            uint32_t deadband;
            int32_t exceededLimit;
        } signedOutOfRange;
#endif
#if BACNET_EVENT_UNSIGNED_OUT_OF_RANGE_ENABLED
        /*  EVENT_UNSIGNED_OUT_OF_RANGE
            unsigned-out-of-range[14] SEQUENCE {
                exceeding-value[0] Unsigned,
                status-flags[1] BACnetStatusFlags,
                deadband[2] Unsigned,
                exceeded-limit[3] Unsigned
            } */
        struct {
            BACNET_UNSIGNED_INTEGER exceedingValue;
            BACNET_BIT_STRING statusFlags;
            BACNET_UNSIGNED_INTEGER deadband;
            BACNET_UNSIGNED_INTEGER exceededLimit;
        } unsignedOutOfRange;
#endif
#if BACNET_EVENT_CHANGE_OF_CHARACTERSTRING_ENABLED
        /*  EVENT_CHANGE_OF_CHARACTERSTRING
            change-of-characterstring [17] SEQUENCE {
                changed-value [0] CharacterString,
                status-flags [1] BACnetStatusFlags,
                alarm-value [2] CharacterString
            } */
        struct {
            BACNET_CHARACTER_STRING *changedValue;
            BACNET_BIT_STRING statusFlags;
            BACNET_CHARACTER_STRING *alarmValue;
        } changeOfCharacterstring;
#endif
#if BACNET_EVENT_CHANGE_OF_STATUS_FLAGS_ENABLED
        /*  EVENT_CHANGE_OF_STATUS_FLAGS
            change-of-status-flags [18] SEQUENCE {
                present-value [0] ABSTRACT-SYNTAX.&Type OPTIONAL,
                -- depends on referenced property
                referenced-flags [1] BACnetStatusFlags
            } */
        /* OPTIONAL - Set present-value.tag to
           BACNET_APPLICATION_TAG_EMPTYLIST if not used */
        struct {
            BACNET_EVENT_EXTENDED_PARAMETER presentValue;
            BACNET_BIT_STRING referencedFlags;
        } changeOfStatusFlags;
#endif
#if BACNET_EVENT_CHANGE_OF_RELIABILITY_ENABLED
        /*  EVENT_CHANGE_OF_RELIABILITY
            change-of-reliability [19] SEQUENCE {
                reliability [0] BACnetReliability,
                status-flags [1] BACnetStatusFlags,
                property-values [2] SEQUENCE OF BACnetPropertyValue
            } */
        struct {
            BACNET_RELIABILITY reliability;
            BACNET_BIT_STRING statusFlags;
            BACNET_PROPERTY_VALUE *propertyValues;
        } changeOfReliability;
#endif
#if BACNET_EVENT_CHANGE_OF_DISCRETE_VALUE_ENABLED
        /*  EVENT_CHANGE_OF_DISCRETE_VALUE
            change-of-discrete-value [21] SEQUENCE {
                new-value [0] CHOICE {
                    boolean BOOLEAN,
                    unsigned Unsigned,
                    integer INTEGER,
                    enumerated ENUMERATED,
                    characterstring CharacterString,
                    octetstring OCTET STRING,
                    date Date,
                    time Time,
                    objectidentifier BACnetObjectIdentifier,
                    datetime [0] BACnetDateTime
                },
                status-flags [1] BACnetStatusFlags
            }*/
        struct {
            BACNET_EVENT_DISCRETE_VALUE newValue;
            BACNET_BIT_STRING statusFlags;
        } changeOfDiscreteValue;
#endif
#if BACNET_EVENT_CHANGE_OF_TIMER_ENABLED
        /*  EVENT_CHANGE_OF_TIMER
            change-of-timer [22] SEQUENCE {
                new-state [0] BACnetTimerState,
                status-flags [1] BACnetStatusFlags,
                update-time [2] BACnetDateTime,
                last-state-change [3] BACnetTimerTransition OPTIONAL,
                initial-timeout [4] Unsigned OPTIONAL,
                expiration-time [5] BACnetDateTime OPTIONAL
            } */
        /* OPTIONAL - Set last-state-change to TIMER_TRANSITION_MAX
           if not used. */
        /* OPTIONAL - Set expiration-time to wildcards if not used. */
        /* OPTIONAL - Set initial-timeout to 0 if not used. */
        struct {
            BACNET_TIMER_STATE newState;
            BACNET_BIT_STRING statusFlags;
            BACNET_DATE_TIME updateTime;
            BACNET_TIMER_TRANSITION lastStateChange;
            BACNET_UNSIGNED_INTEGER initialTimeout;
            BACNET_DATE_TIME expirationTime;
        } changeOfTimer;
#endif
        /*
         ** EVENT_NONE - tag only
         */
#if BACNET_DECODE_COMPLEX_EVENT_TYPE_PARAMETERS
        /*
         * complex-event-type - a sequence of values, used for proprietary event
         * types
         */
        struct {
            BACNET_PROPERTY_VALUE
            values[BACNET_COMPLEX_EVENT_TYPE_MAX_PARAMETERS];
        } complexEventType;
#endif
    } notificationParams;
} BACNET_EVENT_NOTIFICATION_DATA;

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/***************************************************
**
** Creates a Confirmed Event Notification APDU
**
****************************************************/
BACNET_STACK_EXPORT
int cevent_notify_encode_apdu(
    uint8_t *apdu,
    uint8_t invoke_id,
    const BACNET_EVENT_NOTIFICATION_DATA *data);

/***************************************************
**
** Creates an Unconfirmed Event Notification APDU
**
****************************************************/
BACNET_STACK_EXPORT
int uevent_notify_encode_apdu(
    uint8_t *apdu, const BACNET_EVENT_NOTIFICATION_DATA *data);

/***************************************************
**
** Encodes the service data part of Event Notification
**
****************************************************/
BACNET_STACK_EXPORT
int event_notify_encode_service_request(
    uint8_t *apdu, const BACNET_EVENT_NOTIFICATION_DATA *data);

BACNET_STACK_EXPORT
size_t event_notification_service_request_encode(
    uint8_t *apdu,
    size_t apdu_size,
    const BACNET_EVENT_NOTIFICATION_DATA *data);

/***************************************************
**
** Decodes the service data part of Event Notification
**
****************************************************/
BACNET_STACK_EXPORT
int event_notify_decode_service_request(
    const uint8_t *apdu,
    unsigned apdu_len,
    BACNET_EVENT_NOTIFICATION_DATA *data);

/***************************************************
**
** Sends an Unconfirmed Event Notification to a dest
**
****************************************************/
BACNET_STACK_EXPORT
int uevent_notify_send(
    uint8_t *buffer,
    BACNET_EVENT_NOTIFICATION_DATA *data,
    BACNET_ADDRESS *dest);

#ifdef __cplusplus
}
#endif /* __cplusplus */
/** @defgroup ALMEVNT Alarm and Event Management BIBBs
 * These BIBBs prescribe the BACnet capabilities required to interoperably
 * perform the alarm and event management functions enumerated in 22.2.1.2
 * for the BACnet devices defined therein.
 */
/** @defgroup EVNOTFCN Alarm and Event-Notification (AE-N)
 * @ingroup ALMEVNT
 * 13.6 ConfirmedCOVNotification Service <br>
 * The ConfirmedCOVNotification service is used to notify subscribers about
 * changes that may have occurred to the properties of a particular object.
 * Subscriptions for COV notifications are made using the SubscribeCOV service
 * or the SubscribeCOVProperty service.
 *
 * 13.7 UnconfirmedCOVNotification Service <br>
 * The UnconfirmedCOVNotification Service is used to notify subscribers about
 * changes that may have occurred to the properties of a particular object,
 * or to distribute object properties of wide interest (such as outside air
 * conditions) to many devices simultaneously without a subscription.
 * Subscriptions for COV notifications are made using the SubscribeCOV service.
 * For unsubscribed notifications, the algorithm for determining when to issue
 * this service is a local matter and may be based on a change of value,
 * periodic updating, or some other criteria.
 */
/** @defgroup ALMACK  Alarm and Event-ACK (AE-ACK)
 * @ingroup ALMEVNT
 * 13.5 AcknowledgeAlarm Service <br>
 * In some systems a device may need to know that an operator has seen the alarm
 * notification. The AcknowledgeAlarm service is used by a notification-client
 * to acknowledge that a human operator has seen and responded to an event
 * notification with 'AckRequired' = TRUE. Ensuring that the acknowledgment
 * actually comes from a person with appropriate authority is a local matter.
 * This service may be used in conjunction with either the
 * ConfirmedEventNotification service or the
 * UnconfirmedEventNotificationservice.
 */
#endif /* BACNET_EVENT_H_ */
